ZaVoo HTML Menu Generator

------
About:
------
The Zavoo HTML Page Generator was born out of my frustration with other HTML
menu generators. A large number of them require knowledge of XML or a custom
scripting language to define the layout.  The setup alone takes hours of reading
and experimenting to just get them running.  While not as flexible as some
generators, the Zavoo HTML Page Generator offers a very quick and easy setup.
It uses HTML comments in a skeleton HTML file to generate all the subsequent
HTML files.

----------------
Getting Started:
----------------
1) Make sure you have a version of Perl available on your system.

   If you need a copy of Perl try:
      Windows: www.activestate.com
      Linux/Unix: perl.org
      Other: http://www.cpan.org/ports/index.html

   You will also need the following Perl Modules:

   Net::FTP
   Net::SFTP

   You can easily install them using the Perl Package Manager included with the
   ActiveState installation or for *nix use the following:

   perl -MCPAN -e -shell

   Run the following commands inside the PPM or the above shell using the
   default awnsers:

   install Net::FTP
   install Net::SFTP

2) Unzip the page generator into a directory of your choice.

3) Edit the first line of zavoo.pl to point to your Perl binary.
   If you are using Windows and installed ActiveState Perl in the
   default directory this should be "C:\perl\bin\perl.exe".
   *nix commonly uses "/usr/bin/perl".

   At this point you could run the program "zavoo.pl" just to see what will
   happen.  It will use the settings and example files included in the
   archive file.

4) Edit the menu.config file to suite your needs.

   Layout Of menu.config:

   [Level][Text]|[File Name]

   Level:
     "" represents a file in the Root Directory
     "+" represents an entry in the Main Menu
     "++" represent an entry in a Sub Menu (must be placed under a Main Menu)

   Text is the Text you wish to be displayed on the page

   File Name is the name of the html file to be created

   Example:

   Home|index.html
   News Archive|news.html
   +Main Menu Entry|main.html
   ++Sub Menu Entry|sub.html
   ++Another Sub Entry|another.html
   +Another Main Entry|another.html
   ++Sub Entry|sub.html

   You may have noticed the repetition of file names.  When the pages are
   generated each main menu topic receives its own folder. As long as you
   do not use the same file name in the same main topic there will be no
   conflict.

5) Edit the Skeleton HTML File.
   Insert Html Comments where you wish the menus, content, and time stamp to
   appear.

   Note: Do not include the quotation marks.  Also, you can use custom comment
         tags by overriding the default tags in the generator.config file.

   "" is replaced with the Main Menu For Each Page
   "" is replaced with the Sub Menu For Each Page
   "" is replaced with the text from the html files
                        in the 'input' directory
   "" is replaced with a time stamp for when the
                           page was generated

   If you wish the Sub Menu to appear as part of the Main Menu only insert
   the Main Menu Comment. You will need to define where in the Main Menu you
   want the Sub Menu to appear in the generator.config file.

6) Edit the generator.config file.

   This file allows you to configure the appearance of the menu generated.
   See comments in generator.config for details.

7) Run zavoo.pl

   All needed directories will be automatically created provided the program
   has the proper write permissions to do so. It is best to run the program
   from a terminal so you can view any errors or warnings that are generated.

8) Edit the content files in the input directory.

   Each file in the input directory has a counter part in the output directory.
   What you place in the html files in the input directory will be used in
   place of the  in the files generated in the output
   directory.

9) Run zavoo.pl again to update the output html files

----------------
Uploading Files:
----------------
1) Configure the FTP and SFTP settings in your gerneal configuration file.
   If you do not want to store your password in the configuration file you can
   use the -p or -pp flag to specify the password at the time of execution.
   Run 'zavoo -h' for more details.

   If both 'FTP Upload' and 'SFTP Upload' are set to "Yes" then SFTP will be
   used.

2) Similarly to the file generation, a time stamp file is used to determine if
   a file has been modified since the last upload. If you wish to have all
   files uploaded regardless of their modification date use the '-f' flag or
   set 'Force Upload' to "Yes".

3) If you do not have 'FTP Upload' or 'SFTP Upload' set to "Yes" then use the
   '-ftp' or '-sftp' flag on the commandline.

4) Run the program.  After any files are generated, files newer than the
   previous upload will be uploaded.  If this is the first time you have
   uploaded all the files will be uploaded.

-------------------
Questions/Comments:
-------------------
If you have any questions, comments, or suggestions please let me know.

james@zavoo.com